Skip to content

Copy docs workflow #404

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 70 commits into from
May 27, 2025
Merged

Copy docs workflow #404

merged 70 commits into from
May 27, 2025

Conversation

RubenSandwich
Copy link
Contributor

@RubenSandwich RubenSandwich commented May 19, 2025

Ticket

Description

Adds the "Copy Docs" workflow from mktg-content-workflows to UDR.

What this workflow does
On the selected release branch, it copies over terraform-docs-common into ptfe-releases and creates two PRs:

  1. The ACTUAL new ptfe-releases PR which is a new version
  2. The DIFF PR which showcases the changes from the docs last version of ptfe-releases

Future work

Once this work lands in main a few variables will have to be changed:

  1. https://github.com/hashicorp/web-unified-docs/pull/404/files#diff-121670f875c95eee1efdd5b0d05970c837358e530bbe290282e8fb11d7a883f2R91
  2. https://github.com/hashicorp/web-unified-docs/pull/404/files#diff-121670f875c95eee1efdd5b0d05970c837358e530bbe290282e8fb11d7a883f2R154
  3. https://github.com/hashicorp/web-unified-docs/pull/404/files#diff-121670f875c95eee1efdd5b0d05970c837358e530bbe290282e8fb11d7a883f2R227

Testing

  1. Because we cannot workflow dispatch until this work is on main, you will need to run it through the gh CLI:
    gh workflow run "Copy Cloud Docs For TFE" --ref "rn/add-copy-docs-workflow" --field branch="ptfe-releases/v000011-1"
  2. An ACTUAL and DIFF PR should be made for you and linked to in the GitHub action summary.

The branch ptfe-releases/v000011-1 is already made for you.

Copy link

github-actions bot commented May 19, 2025

Vercel Previews Deployed

Name Status Preview Updated (UTC)
Dev Portal ✅ Ready (Inspect) Visit Preview Tue May 27 16:08:29 UTC 2025
Unified Docs API ✅ Ready (Inspect) Visit Preview Tue May 27 16:00:27 UTC 2025

@RubenSandwich RubenSandwich changed the base branch from main to develop May 19, 2025 17:45
@RubenSandwich RubenSandwich changed the title Add enough for barebones test Copy docs workflow May 19, 2025
@RubenSandwich RubenSandwich marked this pull request as ready for review May 23, 2025 20:26
@RubenSandwich RubenSandwich requested a review from a team as a code owner May 23, 2025 20:26
echo "" >> $GITHUB_STEP_SUMMARY
echo "---" >> $GITHUB_STEP_SUMMARY

- name: Checkout workflow ref, ONLY USED FOR TESTING WILL REUSE RELEASE BRANCH CHECKOUT IN PROD
Copy link
Contributor Author

@RubenSandwich RubenSandwich May 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

❗ This step is only required for testing, will be removed after ❗

Copy link
Contributor

@LeahMarieBush LeahMarieBush left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks and works great! The workflow was really fast. I have a few nitpick comments. Also, do we need to change the PR opener from you to hashibot/an automated account?

@RubenSandwich RubenSandwich merged commit 388876c into develop May 27, 2025
6 checks passed
RubenSandwich added a commit that referenced this pull request May 27, 2025
* Migrate terraform-docs-common (#227)

* Migrate terraform-docs-agents (#228)

* Fix content not showing up in preview and link checker checking more than *.mdx files (#226) (#231)

* Broken link checker should only run on .mdx files

* Add a test to catch a broken link

* Edit a JSON file

* Move to always using head.sha when link checking

* Miss a place for the head.sha

* print the changed files

* Move back to using nick-fields/retry

* Fix misspelling and add another test

* Fix wrong var being pass in

* Fix misspelling of variable

* Found another misspelling :face_palm:

* get-changed-files output is space not comma sep

* Give action a clearer name

* Fix dev-portal cache

* Revert testing changes

* Put back space

* Migrate over terraform-cdk (#229)

* API Compare tool for version metadata (#232)

* Add readme

* Update command in package.json

* Add test output folder to gitignore

* Shorten example response

* Add default values for old and new APIs

---------

Co-authored-by: Ruben Nic <[email protected]>

* Fix merge conflict (#252)

* Keep develop in sync with main (#251)

* Fix content not showing up in preview and link checker checking more than *.mdx files (#226)

* Broken link checker should only run on .mdx files

* Add a test to catch a broken link

* Edit a JSON file

* Move to always using head.sha when link checking

* Miss a place for the head.sha

* print the changed files

* Move back to using nick-fields/retry

* Fix misspelling and add another test

* Fix wrong var being pass in

* Fix misspelling of variable

* Found another misspelling :face_palm:

* get-changed-files output is space not comma sep

* Give action a clearer name

* Fix dev-portal cache

* Revert testing changes

* Put back space

* Enable vercel deployment protection bypass (#230)

* Expand lychee command to multiple lines

This makes the arguments easier to read (multiple small lines rather than one
line line that stretches for miles)

* Add vercel protection bypass header to lychee command

* Disable prod workflows outside of public repo (#234)

* Disable prod workflows outside of public repo

* Moving to using job level if

* Mock imports in app/utils/utils.test.ts to run without prebuild step (#238)

* Mock import in app/api/content/[productSlug]/redirects/route.test.ts to run without prebuild step (#241)

* Mock imports in app/api/all-docs-paths/route.test.ts to run without prebuild step (#239)

* Mock imports in app/utils/allDocsPaths.test.ts to run without prebuild step (#237)

* repo sync between public and internal repos for web-unifed-docs GHA (#236)

* Change repo owner to hashicorp in repo-sync workflow (#242)

* Mock import of version metadata in app/api/content/[productSlug]/version-metadata/route.ts (#240)

* Mock import of version metadata (#244)

* Mock import of versionMetadata in app/api/assets/[productSlug]/[version]/[...assetPath]/route.test.ts(#245)

* Mock imports in app/api/content/[productSlug]/doc/[version]/[...docsPath]/route.test.ts (#243)

* Mock imports for versionMetadata.json, docsPathsAllVersions.json, and productConfig.mjs

* Remove path navigation from fixtures import (#1) (#247)

* sync changes from web-unified-docs-internal

* Update method from compareCommits to compareCommitsWithBasehead (#249)

* Remove prebuild from test action (#250)

* Add develop to target branches

---------

Co-authored-by: Ruben Nic <[email protected]>
Co-authored-by: Robert Main <[email protected]>
Co-authored-by: HashiBot <[email protected]>

* api comparison tool: content versions (#340)

* Change arg to d for drop-keys

* Added functionality to test content-versions API

* Add examples to the readme

* Sync changes from main into develop (#344)

* Fix content not showing up in preview and link checker checking more than *.mdx files (#226)

* Broken link checker should only run on .mdx files

* Add a test to catch a broken link

* Edit a JSON file

* Move to always using head.sha when link checking

* Miss a place for the head.sha

* print the changed files

* Move back to using nick-fields/retry

* Fix misspelling and add another test

* Fix wrong var being pass in

* Fix misspelling of variable

* Found another misspelling :face_palm:

* get-changed-files output is space not comma sep

* Give action a clearer name

* Fix dev-portal cache

* Revert testing changes

* Put back space

* Enable vercel deployment protection bypass (#230)

* Expand lychee command to multiple lines

This makes the arguments easier to read (multiple small lines rather than one
line line that stretches for miles)

* Add vercel protection bypass header to lychee command

* Disable prod workflows outside of public repo (#234)

* Disable prod workflows outside of public repo

* Moving to using job level if

* Mock imports in app/utils/utils.test.ts to run without prebuild step (#238)

* Mock import in app/api/content/[productSlug]/redirects/route.test.ts to run without prebuild step (#241)

* Mock imports in app/api/all-docs-paths/route.test.ts to run without prebuild step (#239)

* Mock imports in app/utils/allDocsPaths.test.ts to run without prebuild step (#237)

* repo sync between public and internal repos for web-unifed-docs GHA (#236)

* Change repo owner to hashicorp in repo-sync workflow (#242)

* Mock import of version metadata in app/api/content/[productSlug]/version-metadata/route.ts (#240)

* Mock import of version metadata (#244)

* Mock import of versionMetadata in app/api/assets/[productSlug]/[version]/[...assetPath]/route.test.ts(#245)

* Mock imports in app/api/content/[productSlug]/doc/[version]/[...docsPath]/route.test.ts (#243)

* Mock imports for versionMetadata.json, docsPathsAllVersions.json, and productConfig.mjs

* Remove path navigation from fixtures import (#1)

* Remove path navigation from fixtures import (#1) (#247)

* sync changes from web-unified-docs-internal

* Update method from compareCommits to compareCommitsWithBasehead (#249)

* Remove prebuild from test action (#250)

* Add develop to target branches

* Remove paths arg to allow Test & Lint action to run on every PR (#253)

* Remove PR lock logic from repo-sync workflow (#263)

* Repo sync (#34)

* Remove path navigation from fixtures import (#1) (#247)

* sync changes from web-unified-docs-internal

* Update method from compareCommits to compareCommitsWithBasehead (#249)

* Remove prebuild from test action (#250)

* Add develop to target branches

* Remove paths arg to allow Test & Lint action to run on every PR (#253)

* Remove PR lock logic from repo-sync workflow (#263)

---------

Co-authored-by: Heat Hamilton <[email protected]>

* Repo sync (#291)



* Repo sync (#34)

* sync changes from web-unified-docs-internal

* Update method from compareCommits to compareCommitsWithBasehead (#249)

* Remove prebuild from test action (#250)

* Add develop to target branches

* Remove paths arg to allow Test & Lint action to run on every PR (#253)

* Remove PR lock logic from repo-sync workflow (#263)

---------

Co-authored-by: Heat Hamilton <[email protected]>

* Repo sync (#38)

* sync changes from web-unified-docs-internal

* Update method from compareCommits to compareCommitsWithBasehead (#249)

* Remove prebuild from test action (#250)

* Add develop to target branches

* Remove paths arg to allow Test & Lint action to run on every PR (#253)

* Remove PR lock logic from repo-sync workflow (#263)

---------

Co-authored-by: Heat Hamilton <[email protected]>

* Add Vercel link to deploy preview (#39)

* Add Vercel link to deploy job (#290)

* Fix for dev-portal is failing to build in UDR internal repo

* Repo sync (#326)

* Repo sync (#73)

* Fix content loading (#235)

* Use vercel protection bypass headcer

Builds were previously breaking when UDR attempted to make HTTP requests to the
CDN (vercel public folder) to retrieve content.

Adding the `x-vercel-protection-bypass` header should fix that

* Add use server directive

* Revert "Add use server directive"

Adding a 'use server' directive to this file causes 404s on the content
API.

This reverts commit 4f2ecae.

---------

Co-authored-by: Ruben Nic <[email protected]>
Co-authored-by: Heat Hamilton <[email protected]>
Co-authored-by: HashiBot <[email protected]>

* Remove terraform docs common (#342)

* Remove terraform-docs-common from develop branch

* Comment out terraform-docs-common

Disable terraform-docs-common in product config

* Undo removal of content dir mapping

---------

Co-authored-by: Heat Hamilton <[email protected]>

* Add terraform-docs-agents (#345)

* remove terraform-cdk docs (#347)

* Re-sync terraform-docs-agents docs (#348)

Co-authored-by: Ruben Nic <[email protected]>

* Update image file paths for terraform-docs-agents (#350)

* Change image path from public/img to img

Comment out themed images and add TODO for when this is supported

Add TODO to remove non-themed image once themed images are supported

* Remove commented out images

* Delete images from v1.15.x and v1.16.x

* Copy over images from v1.17.x

* Add ptfe release PR request template

* Add TFE release notes workflow (#367)

* Add clone services repo script

* Move config files into script folder

* Add execute changelog script

* add create pull request script

* add workflow file

* Workflow needs to run once to test

* Add the release notes PR url to the summary

* Correctly get env.VERSION

* Correctly expand PR_URL

* Just don't use PR_URL as it isn't expanding

* Remove push dispatch, as no longer needed

* I don't believe PR_NUMBER is being set correctly

* Set PR_NUMBER in multiple steps

* Try each step separately

* Return pr_url from ruby

* Let pr_url should be a var

* Should be double quotes

* Fix summary output

* Add gem lock file

* Add push so I can test workflow

* A few more places where ptfe-releases is used

* Rename ptfe -> tfe

* content folder should be terraform-enterprise

* Forgot to update release_file loc

* Prevent from running in public UDR

* Output public UDR error to GITHUB_STEP_SUMMARY

* Apply suggestions from code review

Co-authored-by: Leah Bush <[email protected]>

* Remove commented out code

---------

Co-authored-by: Leah Bush <[email protected]>

* Add in ptfe-releases content (#393)

* Add in ptfe-releases content

* Add tfe-releases copyright headers

* feat: add terraform-docs-common to develop branch (#395)

* Copy docs workflow (#404)

* Add enough for barebones test

* Add push for testing

* Fix workflow name

* Add test file at root to check that PR opens

* login with github token

* Update gh token

* Try just a git push

* Add back push head

* merge into develop for now

* Remove push action

* remove comment that was messing up code

* Get copy-cloud-docs-for-tfe compiling

* Only building only version metadata

* Refactor to remove targetRepoLastSyncFile

* Downgrade remark to fix mdx v2 errors

* Get Copy cloud-docs for TFE working

* Check if the branch name already exists

* Fix type errors

* Update the README with the new name

* Test the whole workflow connected together

* checkout the proper workflow file before running

* path should be a string

* forgot a period

* Use latest sha for GHA run

* Forgot to build 🤦

* double check that the checkout is working

* Add the current loc to checkout

* try the path just "testing"

* include the github workspace

* It's github.workspace

* checkout is deleting previous folder contents

* Double check that the files are being moved over

* fix move command

* fix a space in path

* list files for debugging

* What is in our base dir

* copy dot files

* correct file path

* For demo only add changed files in /ptfe-releases

* For the sake of the demo do a clean PR

* Forgot to rebuild

* base against develop

* new-pr checkout should be develop as well

* clean up testing code

* Don't copy over /architectural-details

* Corrected new-pr path

* prebuild-only-version-metadata exists in branch

* Correctly fetch the origin branch

* use working-directory

* Rewrite to support two different PRs

* Resolve the versionMetadataPath

* Fix working dir and branch checking code

* Remove branch checking code

* Try a new way to check for a branch existing

* try again for branch checking

* should be a "do not equals"

* Update bot user

* Add diff PR to workflow

* Update PR names

* Update a bit of the wording

* Remove testing code

* Trigger copy docs from release notes workflow

* delete old tests as they are no longer being used

* Add copywrite headers

* Add todos to workflow

* Add parenthesis around closed message

* Update README and remove code comment

* Remove TODOs and base off of main

* Update .github/actions/copy-cloud-docs-for-tfe/main.ts

Co-authored-by: Robert Main <[email protected]>

---------

Co-authored-by: Heat Hamilton <[email protected]>
Co-authored-by: Robert Main <[email protected]>
Co-authored-by: HashiBot <[email protected]>
Co-authored-by: Leah Bush <[email protected]>
Co-authored-by: Leah Bush <[email protected]>
hashibot-web added a commit that referenced this pull request May 29, 2025
* Merge develop into main (#392)

* Migrate terraform-docs-common (#227)

* Migrate terraform-docs-agents (#228)

* Fix content not showing up in preview and link checker checking more than *.mdx files (#226) (#231)

* Broken link checker should only run on .mdx files

* Add a test to catch a broken link

* Edit a JSON file

* Move to always using head.sha when link checking

* Miss a place for the head.sha

* print the changed files

* Move back to using nick-fields/retry

* Fix misspelling and add another test

* Fix wrong var being pass in

* Fix misspelling of variable

* Found another misspelling :face_palm:

* get-changed-files output is space not comma sep

* Give action a clearer name

* Fix dev-portal cache

* Revert testing changes

* Put back space

* Migrate over terraform-cdk (#229)

* API Compare tool for version metadata (#232)

* Add readme

* Update command in package.json

* Add test output folder to gitignore

* Shorten example response

* Add default values for old and new APIs

---------

Co-authored-by: Ruben Nic <[email protected]>

* Fix merge conflict (#252)

* Keep develop in sync with main (#251)

* Fix content not showing up in preview and link checker checking more than *.mdx files (#226)

* Broken link checker should only run on .mdx files

* Add a test to catch a broken link

* Edit a JSON file

* Move to always using head.sha when link checking

* Miss a place for the head.sha

* print the changed files

* Move back to using nick-fields/retry

* Fix misspelling and add another test

* Fix wrong var being pass in

* Fix misspelling of variable

* Found another misspelling :face_palm:

* get-changed-files output is space not comma sep

* Give action a clearer name

* Fix dev-portal cache

* Revert testing changes

* Put back space

* Enable vercel deployment protection bypass (#230)

* Expand lychee command to multiple lines

This makes the arguments easier to read (multiple small lines rather than one
line line that stretches for miles)

* Add vercel protection bypass header to lychee command

* Disable prod workflows outside of public repo (#234)

* Disable prod workflows outside of public repo

* Moving to using job level if

* Mock imports in app/utils/utils.test.ts to run without prebuild step (#238)

* Mock import in app/api/content/[productSlug]/redirects/route.test.ts to run without prebuild step (#241)

* Mock imports in app/api/all-docs-paths/route.test.ts to run without prebuild step (#239)

* Mock imports in app/utils/allDocsPaths.test.ts to run without prebuild step (#237)

* repo sync between public and internal repos for web-unifed-docs GHA (#236)

* Change repo owner to hashicorp in repo-sync workflow (#242)

* Mock import of version metadata in app/api/content/[productSlug]/version-metadata/route.ts (#240)

* Mock import of version metadata (#244)

* Mock import of versionMetadata in app/api/assets/[productSlug]/[version]/[...assetPath]/route.test.ts(#245)

* Mock imports in app/api/content/[productSlug]/doc/[version]/[...docsPath]/route.test.ts (#243)

* Mock imports for versionMetadata.json, docsPathsAllVersions.json, and productConfig.mjs

* Remove path navigation from fixtures import (#1) (#247)

* sync changes from web-unified-docs-internal

* Update method from compareCommits to compareCommitsWithBasehead (#249)

* Remove prebuild from test action (#250)

* Add develop to target branches

---------

Co-authored-by: Ruben Nic <[email protected]>
Co-authored-by: Robert Main <[email protected]>
Co-authored-by: HashiBot <[email protected]>

* api comparison tool: content versions (#340)

* Change arg to d for drop-keys

* Added functionality to test content-versions API

* Add examples to the readme

* Sync changes from main into develop (#344)

* Fix content not showing up in preview and link checker checking more than *.mdx files (#226)

* Broken link checker should only run on .mdx files

* Add a test to catch a broken link

* Edit a JSON file

* Move to always using head.sha when link checking

* Miss a place for the head.sha

* print the changed files

* Move back to using nick-fields/retry

* Fix misspelling and add another test

* Fix wrong var being pass in

* Fix misspelling of variable

* Found another misspelling :face_palm:

* get-changed-files output is space not comma sep

* Give action a clearer name

* Fix dev-portal cache

* Revert testing changes

* Put back space

* Enable vercel deployment protection bypass (#230)

* Expand lychee command to multiple lines

This makes the arguments easier to read (multiple small lines rather than one
line line that stretches for miles)

* Add vercel protection bypass header to lychee command

* Disable prod workflows outside of public repo (#234)

* Disable prod workflows outside of public repo

* Moving to using job level if

* Mock imports in app/utils/utils.test.ts to run without prebuild step (#238)

* Mock import in app/api/content/[productSlug]/redirects/route.test.ts to run without prebuild step (#241)

* Mock imports in app/api/all-docs-paths/route.test.ts to run without prebuild step (#239)

* Mock imports in app/utils/allDocsPaths.test.ts to run without prebuild step (#237)

* repo sync between public and internal repos for web-unifed-docs GHA (#236)

* Change repo owner to hashicorp in repo-sync workflow (#242)

* Mock import of version metadata in app/api/content/[productSlug]/version-metadata/route.ts (#240)

* Mock import of version metadata (#244)

* Mock import of versionMetadata in app/api/assets/[productSlug]/[version]/[...assetPath]/route.test.ts(#245)

* Mock imports in app/api/content/[productSlug]/doc/[version]/[...docsPath]/route.test.ts (#243)

* Mock imports for versionMetadata.json, docsPathsAllVersions.json, and productConfig.mjs

* Remove path navigation from fixtures import (#1)

* Remove path navigation from fixtures import (#1) (#247)

* sync changes from web-unified-docs-internal

* Update method from compareCommits to compareCommitsWithBasehead (#249)

* Remove prebuild from test action (#250)

* Add develop to target branches

* Remove paths arg to allow Test & Lint action to run on every PR (#253)

* Remove PR lock logic from repo-sync workflow (#263)

* Repo sync (#34)

* Remove path navigation from fixtures import (#1) (#247)

* sync changes from web-unified-docs-internal

* Update method from compareCommits to compareCommitsWithBasehead (#249)

* Remove prebuild from test action (#250)

* Add develop to target branches

* Remove paths arg to allow Test & Lint action to run on every PR (#253)

* Remove PR lock logic from repo-sync workflow (#263)

---------

Co-authored-by: Heat Hamilton <[email protected]>

* Repo sync (#291)



* Repo sync (#34)

* sync changes from web-unified-docs-internal

* Update method from compareCommits to compareCommitsWithBasehead (#249)

* Remove prebuild from test action (#250)

* Add develop to target branches

* Remove paths arg to allow Test & Lint action to run on every PR (#253)

* Remove PR lock logic from repo-sync workflow (#263)

---------

Co-authored-by: Heat Hamilton <[email protected]>

* Repo sync (#38)

* sync changes from web-unified-docs-internal

* Update method from compareCommits to compareCommitsWithBasehead (#249)

* Remove prebuild from test action (#250)

* Add develop to target branches

* Remove paths arg to allow Test & Lint action to run on every PR (#253)

* Remove PR lock logic from repo-sync workflow (#263)

---------

Co-authored-by: Heat Hamilton <[email protected]>

* Add Vercel link to deploy preview (#39)

* Add Vercel link to deploy job (#290)

* Fix for dev-portal is failing to build in UDR internal repo

* Repo sync (#326)

* Repo sync (#73)

* Fix content loading (#235)

* Use vercel protection bypass headcer

Builds were previously breaking when UDR attempted to make HTTP requests to the
CDN (vercel public folder) to retrieve content.

Adding the `x-vercel-protection-bypass` header should fix that

* Add use server directive

* Revert "Add use server directive"

Adding a 'use server' directive to this file causes 404s on the content
API.

This reverts commit 4f2ecae.

---------

Co-authored-by: Ruben Nic <[email protected]>
Co-authored-by: Heat Hamilton <[email protected]>
Co-authored-by: HashiBot <[email protected]>

* Remove terraform docs common (#342)

* Remove terraform-docs-common from develop branch

* Comment out terraform-docs-common

Disable terraform-docs-common in product config

* Undo removal of content dir mapping

---------

Co-authored-by: Heat Hamilton <[email protected]>

* Add terraform-docs-agents (#345)

* remove terraform-cdk docs (#347)

* Re-sync terraform-docs-agents docs (#348)

Co-authored-by: Ruben Nic <[email protected]>

* Update image file paths for terraform-docs-agents (#350)

* Change image path from public/img to img

Comment out themed images and add TODO for when this is supported

Add TODO to remove non-themed image once themed images are supported

* Remove commented out images

* Delete images from v1.15.x and v1.16.x

* Copy over images from v1.17.x

* Add ptfe release PR request template

* Add TFE release notes workflow (#367)

* Add clone services repo script

* Move config files into script folder

* Add execute changelog script

* add create pull request script

* add workflow file

* Workflow needs to run once to test

* Add the release notes PR url to the summary

* Correctly get env.VERSION

* Correctly expand PR_URL

* Just don't use PR_URL as it isn't expanding

* Remove push dispatch, as no longer needed

* I don't believe PR_NUMBER is being set correctly

* Set PR_NUMBER in multiple steps

* Try each step separately

* Return pr_url from ruby

* Let pr_url should be a var

* Should be double quotes

* Fix summary output

* Add gem lock file

* Add push so I can test workflow

* A few more places where ptfe-releases is used

* Rename ptfe -> tfe

* content folder should be terraform-enterprise

* Forgot to update release_file loc

* Prevent from running in public UDR

* Output public UDR error to GITHUB_STEP_SUMMARY

* Apply suggestions from code review

Co-authored-by: Leah Bush <[email protected]>

* Remove commented out code

---------

Co-authored-by: Leah Bush <[email protected]>

---------

Co-authored-by: Heat Hamilton <[email protected]>
Co-authored-by: Robert Main <[email protected]>
Co-authored-by: HashiBot <[email protected]>
Co-authored-by: Leah Bush <[email protected]>

* Add tfe-releases copyright headers (#394)

* Updates for tfc-agent release 1.22.2

* Undo generated removal of include policy

* Compress upload into gzipped tarball (#396)

* Compress upload into gzipped tarball

This helps to resolve an issue that was breaking preview deploys where
too many files were being uploaded at once

* Move command option within parens

Accidentally added the `--archive` option outside parens which would result in it not being passed to `vercel` as intended.

Co-authored-by: Leah Bush <[email protected]>

* Bundle vercel deployment into tgz archive for prod

Similar to 518efc4 - update the deploy UDR action to first bundle
everything into a tgz archive prior to upload to vercel to avoid hitting
API file count limits (8000 for enterprise plans)

* Add base branch for testing to GH action

* Remove branch name from pull_request_target

---------

Co-authored-by: Leah Bush <[email protected]>

* feat: add all-docs-paths to compare-api-responses script (#391)

* Add `[email protected]` documentation (#400)

* Add `[email protected]` documentation (#346)

* initial copy of terraform-plugin-testing 1.12.x to 1.13.x

$ cp -r content/terraform-plugin-testing/v1.12.x content/terraform-plugin-testing/v1.13.x
$ git add content/terraform-plugin-testing/v1.13.x

* Add import mode to testing-patterns.mdx

* fixup! Add import mode to testing-patterns.mdx

* Update content/terraform-plugin-testing/v1.13.x/docs/plugin/testing/testing-patterns.mdx

* Update content/terraform-plugin-testing/v1.13.x/docs/plugin/testing/testing-patterns.mdx

Co-authored-by: Austin Valle <[email protected]>

* Add teststep subsection for import mode

* Add teststep subsection for import mode

* Add teststep subsection for import mode

* Expand on import mode

* Update plugin/testing/acceptance-tests/index.mdx

* Update acceptance-tests/index.mdx

* Update acceptance-tests/index.mdx

* em dash

* Update acceptance-tests/continuous-integration

* Update acceptance-tests/index.mdx

* Update import-mode.mdx

* Update acceptance-tests/index.mdx

* tidy

* Update testing/index.mdx

* Update testing/index.mdx

* Update testing nav

* Update testing/index.mdx

* Update testing/index.mdx

* Fix code block

* Update testing/*

* Simplify acceptance-tests

* Omit import example

* Update content/terraform-plugin-testing/v1.13.x/docs/plugin/testing/acceptance-tests/environment-variables.mdx

Co-authored-by: Austin Valle <[email protected]>

* Fix environment-variables.mdx formatting

* Fix environment-variables.mdx formatting

* Tidy

* Update content/terraform-plugin-testing/v1.13.x/docs/plugin/testing/acceptance-tests/continuous-integration.mdx

Co-authored-by: Austin Valle <[email protected]>

* Update content/terraform-plugin-testing/v1.13.x/docs/plugin/testing/acceptance-tests/import-mode.mdx

Co-authored-by: Austin Valle <[email protected]>

* Apply suggestions from code review

Co-authored-by: Austin Valle <[email protected]>

* Tidy

* Make heading H1

* Tidy import-mode

---------

Co-authored-by: Austin Valle <[email protected]>

* Add `[email protected]` documentation (#355)

* copy 1.14.x to new folder

* Framework - Resource Identity Documentation (#361)

* add skeleton of thoughts on doc updates

* Initial update to reflect the addition of resource identity.mdx

* Second update of documentation to address some comments

* Removing extra line

* Update content/terraform-plugin-framework/v1.15.x/docs/plugin/framework/resources/identity.mdx

Co-authored-by: Rose M Koron <[email protected]>

* adjust type pages

* Apply suggestions from code review

Co-authored-by: Rose M Koron <[email protected]>

* remove stack + note callout

* add to nav

* update code examples and change name back

* update identity docs

* more identity updates

* updates + todos

* space

* remove sections

* last updates to identity docs

---------

Co-authored-by: Rain <[email protected]>
Co-authored-by: Rain Kwan <[email protected]>
Co-authored-by: Rose M Koron <[email protected]>

---------

Co-authored-by: Rain <[email protected]>
Co-authored-by: Rain Kwan <[email protected]>
Co-authored-by: Rose M Koron <[email protected]>

* Make agent eng team owners of agent docs

* Ignore gnu.org domain in link checker (#401)

* ignore gnu domain in link checker

* Test to make sure that the GNU domain is skipped

* Add `terraform-plugin-sdk/[email protected]` documentation (#356)

* copy v2.36.x to new folder

* add identity changes (#402)

* Merge develop into main in preparation for launch (#425)

* Migrate terraform-docs-common (#227)

* Migrate terraform-docs-agents (#228)

* Fix content not showing up in preview and link checker checking more than *.mdx files (#226) (#231)

* Broken link checker should only run on .mdx files

* Add a test to catch a broken link

* Edit a JSON file

* Move to always using head.sha when link checking

* Miss a place for the head.sha

* print the changed files

* Move back to using nick-fields/retry

* Fix misspelling and add another test

* Fix wrong var being pass in

* Fix misspelling of variable

* Found another misspelling :face_palm:

* get-changed-files output is space not comma sep

* Give action a clearer name

* Fix dev-portal cache

* Revert testing changes

* Put back space

* Migrate over terraform-cdk (#229)

* API Compare tool for version metadata (#232)

* Add readme

* Update command in package.json

* Add test output folder to gitignore

* Shorten example response

* Add default values for old and new APIs

---------

Co-authored-by: Ruben Nic <[email protected]>

* Fix merge conflict (#252)

* Keep develop in sync with main (#251)

* Fix content not showing up in preview and link checker checking more than *.mdx files (#226)

* Broken link checker should only run on .mdx files

* Add a test to catch a broken link

* Edit a JSON file

* Move to always using head.sha when link checking

* Miss a place for the head.sha

* print the changed files

* Move back to using nick-fields/retry

* Fix misspelling and add another test

* Fix wrong var being pass in

* Fix misspelling of variable

* Found another misspelling :face_palm:

* get-changed-files output is space not comma sep

* Give action a clearer name

* Fix dev-portal cache

* Revert testing changes

* Put back space

* Enable vercel deployment protection bypass (#230)

* Expand lychee command to multiple lines

This makes the arguments easier to read (multiple small lines rather than one
line line that stretches for miles)

* Add vercel protection bypass header to lychee command

* Disable prod workflows outside of public repo (#234)

* Disable prod workflows outside of public repo

* Moving to using job level if

* Mock imports in app/utils/utils.test.ts to run without prebuild step (#238)

* Mock import in app/api/content/[productSlug]/redirects/route.test.ts to run without prebuild step (#241)

* Mock imports in app/api/all-docs-paths/route.test.ts to run without prebuild step (#239)

* Mock imports in app/utils/allDocsPaths.test.ts to run without prebuild step (#237)

* repo sync between public and internal repos for web-unifed-docs GHA (#236)

* Change repo owner to hashicorp in repo-sync workflow (#242)

* Mock import of version metadata in app/api/content/[productSlug]/version-metadata/route.ts (#240)

* Mock import of version metadata (#244)

* Mock import of versionMetadata in app/api/assets/[productSlug]/[version]/[...assetPath]/route.test.ts(#245)

* Mock imports in app/api/content/[productSlug]/doc/[version]/[...docsPath]/route.test.ts (#243)

* Mock imports for versionMetadata.json, docsPathsAllVersions.json, and productConfig.mjs

* Remove path navigation from fixtures import (#1) (#247)

* sync changes from web-unified-docs-internal

* Update method from compareCommits to compareCommitsWithBasehead (#249)

* Remove prebuild from test action (#250)

* Add develop to target branches

---------

Co-authored-by: Ruben Nic <[email protected]>
Co-authored-by: Robert Main <[email protected]>
Co-authored-by: HashiBot <[email protected]>

* api comparison tool: content versions (#340)

* Change arg to d for drop-keys

* Added functionality to test content-versions API

* Add examples to the readme

* Sync changes from main into develop (#344)

* Fix content not showing up in preview and link checker checking more than *.mdx files (#226)

* Broken link checker should only run on .mdx files

* Add a test to catch a broken link

* Edit a JSON file

* Move to always using head.sha when link checking

* Miss a place for the head.sha

* print the changed files

* Move back to using nick-fields/retry

* Fix misspelling and add another test

* Fix wrong var being pass in

* Fix misspelling of variable

* Found another misspelling :face_palm:

* get-changed-files output is space not comma sep

* Give action a clearer name

* Fix dev-portal cache

* Revert testing changes

* Put back space

* Enable vercel deployment protection bypass (#230)

* Expand lychee command to multiple lines

This makes the arguments easier to read (multiple small lines rather than one
line line that stretches for miles)

* Add vercel protection bypass header to lychee command

* Disable prod workflows outside of public repo (#234)

* Disable prod workflows outside of public repo

* Moving to using job level if

* Mock imports in app/utils/utils.test.ts to run without prebuild step (#238)

* Mock import in app/api/content/[productSlug]/redirects/route.test.ts to run without prebuild step (#241)

* Mock imports in app/api/all-docs-paths/route.test.ts to run without prebuild step (#239)

* Mock imports in app/utils/allDocsPaths.test.ts to run without prebuild step (#237)

* repo sync between public and internal repos for web-unifed-docs GHA (#236)

* Change repo owner to hashicorp in repo-sync workflow (#242)

* Mock import of version metadata in app/api/content/[productSlug]/version-metadata/route.ts (#240)

* Mock import of version metadata (#244)

* Mock import of versionMetadata in app/api/assets/[productSlug]/[version]/[...assetPath]/route.test.ts(#245)

* Mock imports in app/api/content/[productSlug]/doc/[version]/[...docsPath]/route.test.ts (#243)

* Mock imports for versionMetadata.json, docsPathsAllVersions.json, and productConfig.mjs

* Remove path navigation from fixtures import (#1)

* Remove path navigation from fixtures import (#1) (#247)

* sync changes from web-unified-docs-internal

* Update method from compareCommits to compareCommitsWithBasehead (#249)

* Remove prebuild from test action (#250)

* Add develop to target branches

* Remove paths arg to allow Test & Lint action to run on every PR (#253)

* Remove PR lock logic from repo-sync workflow (#263)

* Repo sync (#34)

* Remove path navigation from fixtures import (#1) (#247)

* sync changes from web-unified-docs-internal

* Update method from compareCommits to compareCommitsWithBasehead (#249)

* Remove prebuild from test action (#250)

* Add develop to target branches

* Remove paths arg to allow Test & Lint action to run on every PR (#253)

* Remove PR lock logic from repo-sync workflow (#263)

---------

Co-authored-by: Heat Hamilton <[email protected]>

* Repo sync (#291)



* Repo sync (#34)

* sync changes from web-unified-docs-internal

* Update method from compareCommits to compareCommitsWithBasehead (#249)

* Remove prebuild from test action (#250)

* Add develop to target branches

* Remove paths arg to allow Test & Lint action to run on every PR (#253)

* Remove PR lock logic from repo-sync workflow (#263)

---------

Co-authored-by: Heat Hamilton <[email protected]>

* Repo sync (#38)

* sync changes from web-unified-docs-internal

* Update method from compareCommits to compareCommitsWithBasehead (#249)

* Remove prebuild from test action (#250)

* Add develop to target branches

* Remove paths arg to allow Test & Lint action to run on every PR (#253)

* Remove PR lock logic from repo-sync workflow (#263)

---------

Co-authored-by: Heat Hamilton <[email protected]>

* Add Vercel link to deploy preview (#39)

* Add Vercel link to deploy job (#290)

* Fix for dev-portal is failing to build in UDR internal repo

* Repo sync (#326)

* Repo sync (#73)

* Fix content loading (#235)

* Use vercel protection bypass headcer

Builds were previously breaking when UDR attempted to make HTTP requests to the
CDN (vercel public folder) to retrieve content.

Adding the `x-vercel-protection-bypass` header should fix that

* Add use server directive

* Revert "Add use server directive"

Adding a 'use server' directive to this file causes 404s on the content
API.

This reverts commit 4f2ecae.

---------

Co-authored-by: Ruben Nic <[email protected]>
Co-authored-by: Heat Hamilton <[email protected]>
Co-authored-by: HashiBot <[email protected]>

* Remove terraform docs common (#342)

* Remove terraform-docs-common from develop branch

* Comment out terraform-docs-common

Disable terraform-docs-common in product config

* Undo removal of content dir mapping

---------

Co-authored-by: Heat Hamilton <[email protected]>

* Add terraform-docs-agents (#345)

* remove terraform-cdk docs (#347)

* Re-sync terraform-docs-agents docs (#348)

Co-authored-by: Ruben Nic <[email protected]>

* Update image file paths for terraform-docs-agents (#350)

* Change image path from public/img to img

Comment out themed images and add TODO for when this is supported

Add TODO to remove non-themed image once themed images are supported

* Remove commented out images

* Delete images from v1.15.x and v1.16.x

* Copy over images from v1.17.x

* Add ptfe release PR request template

* Add TFE release notes workflow (#367)

* Add clone services repo script

* Move config files into script folder

* Add execute changelog script

* add create pull request script

* add workflow file

* Workflow needs to run once to test

* Add the release notes PR url to the summary

* Correctly get env.VERSION

* Correctly expand PR_URL

* Just don't use PR_URL as it isn't expanding

* Remove push dispatch, as no longer needed

* I don't believe PR_NUMBER is being set correctly

* Set PR_NUMBER in multiple steps

* Try each step separately

* Return pr_url from ruby

* Let pr_url should be a var

* Should be double quotes

* Fix summary output

* Add gem lock file

* Add push so I can test workflow

* A few more places where ptfe-releases is used

* Rename ptfe -> tfe

* content folder should be terraform-enterprise

* Forgot to update release_file loc

* Prevent from running in public UDR

* Output public UDR error to GITHUB_STEP_SUMMARY

* Apply suggestions from code review

Co-authored-by: Leah Bush <[email protected]>

* Remove commented out code

---------

Co-authored-by: Leah Bush <[email protected]>

* Add in ptfe-releases content (#393)

* Add in ptfe-releases content

* Add tfe-releases copyright headers

* feat: add terraform-docs-common to develop branch (#395)

* Copy docs workflow (#404)

* Add enough for barebones test

* Add push for testing

* Fix workflow name

* Add test file at root to check that PR opens

* login with github token

* Update gh token

* Try just a git push

* Add back push head

* merge into develop for now

* Remove push action

* remove comment that was messing up code

* Get copy-cloud-docs-for-tfe compiling

* Only building only version metadata

* Refactor to remove targetRepoLastSyncFile

* Downgrade remark to fix mdx v2 errors

* Get Copy cloud-docs for TFE working

* Check if the branch name already exists

* Fix type errors

* Update the README with the new name

* Test the whole workflow connected together

* checkout the proper workflow file before running

* path should be a string

* forgot a period

* Use latest sha for GHA run

* Forgot to build 🤦

* double check that the checkout is working

* Add the current loc to checkout

* try the path just "testing"

* include the github workspace

* It's github.workspace

* checkout is deleting previous folder contents

* Double check that the files are being moved over

* fix move command

* fix a space in path

* list files for debugging

* What is in our base dir

* copy dot files

* correct file path

* For demo only add changed files in /ptfe-releases

* For the sake of the demo do a clean PR

* Forgot to rebuild

* base against develop

* new-pr checkout should be develop as well

* clean up testing code

* Don't copy over /architectural-details

* Corrected new-pr path

* prebuild-only-version-metadata exists in branch

* Correctly fetch the origin branch

* use working-directory

* Rewrite to support two different PRs

* Resolve the versionMetadataPath

* Fix working dir and branch checking code

* Remove branch checking code

* Try a new way to check for a branch existing

* try again for branch checking

* should be a "do not equals"

* Update bot user

* Add diff PR to workflow

* Update PR names

* Update a bit of the wording

* Remove testing code

* Trigger copy docs from release notes workflow

* delete old tests as they are no longer being used

* Add copywrite headers

* Add todos to workflow

* Add parenthesis around closed message

* Update README and remove code comment

* Remove TODOs and base off of main

* Update .github/actions/copy-cloud-docs-for-tfe/main.ts

Co-authored-by: Robert Main <[email protected]>

---------

Co-authored-by: Heat Hamilton <[email protected]>
Co-authored-by: Robert Main <[email protected]>
Co-authored-by: HashiBot <[email protected]>
Co-authored-by: Leah Bush <[email protected]>
Co-authored-by: Leah Bush <[email protected]>

* Forgot to update a path (#426)

* Forgot one other path... (#428)

* Actually update the path (#429)

* Update path in GHA (#430)

* Update path in GHA

* update build output

* Rename ptfe-releases to terraform-enterprise (#419)

* Rename PTFE Release Folder

Renames PTFE releases folder to terraform-enterprise

* Change PTFE Releases Product Config to TFE

* Redirect /ptfe-releases to /terraform-enterprise

* Update reference to ptfe-releases

Update code comments to make reference to terraform-enterprise, not
pfe-releases

* Add missing license header

* Update mermaid README diagram

Terraform is about to be migrated to UDR, so this diagram needed to be
updated to reflect that

* Refactor to remove references to ptfe-releases

Since #425 got merged into the base branch before this PR, additional
references to `/ptfe-releases` were re-introduced. These needed to be
removed in order for things to build and load correctly.

* Don't check compiled actions for missing copyright header (#436)

The content of this action is(somewhat) auto generated by `ncc` meaning we don't have a great deal of control over its content. Therefore, we can probably safely ignore it when checking for missing copyright headers as it is isn't a source file

* fix terraform docs common metadata (#438)

* Assign a placeholder version for unversioned docs

* Move all TFC versions to 'v0.0.x'

* Give version less docs a version

* Use PRODUCT_CONFIG when we can

* fix sitemaps for terraform-docs-common

* Check PRODUCT_CONFIG in more places

* fix file path

* remove console.log

* fix docs route tests

* change back to null

* fix more tests

* fix gather-version tests

* fix test

* put aloglia check back

* fix tests

* remove extra console.log

---------

Co-authored-by: Leah Bush <[email protected]>

* Updates for tfc-agent release 1.22.3

* chore: add terraform docs to UDR (#437)

* Add `[email protected]` documentation (#424)

* Update codeowners for ptfe and tdc (#441)

* Add terraform-docs-common CODEOWNERS

* Add terraform-enterprise to CODEOWNERS

* Add missing team to terraform-docs-common

* chore: add terraform teams to codeowners (#442)

* chore: add terraform teams to codeowners

* add terraform backend codeowners

* use wildcards

* Sync ptfe-releases and terraform-docs-common docs (#440)

* terraform-docs-common

* terraform-enterprise

* Apply middleware to all api routes (#451)

* Initial draft

* do a dirty rewrite for query params

---------

Co-authored-by: Ruben Nic <[email protected]>
Co-authored-by: Heat Hamilton <[email protected]>
Co-authored-by: Robert Main <[email protected]>
Co-authored-by: Leah Bush <[email protected]>
Co-authored-by: Claire Knutson <[email protected]>
Co-authored-by: Claire Knutson <[email protected]>
Co-authored-by: Austin Valle <[email protected]>
Co-authored-by: Baraa Basata <[email protected]>
Co-authored-by: Rain <[email protected]>
Co-authored-by: Rain Kwan <[email protected]>
Co-authored-by: Rose M Koron <[email protected]>
Co-authored-by: Krista LaFentres <[email protected]>
Co-authored-by: Leah Bush <[email protected]>
Co-authored-by: Kelsi Hoyle <[email protected]>
hashibot-web added a commit that referenced this pull request May 29, 2025
* Merge develop into main (#392)

* Migrate terraform-docs-common (#227)

* Migrate terraform-docs-agents (#228)

* Fix content not showing up in preview and link checker checking more than *.mdx files (#226) (#231)

* Broken link checker should only run on .mdx files

* Add a test to catch a broken link

* Edit a JSON file

* Move to always using head.sha when link checking

* Miss a place for the head.sha

* print the changed files

* Move back to using nick-fields/retry

* Fix misspelling and add another test

* Fix wrong var being pass in

* Fix misspelling of variable

* Found another misspelling :face_palm:

* get-changed-files output is space not comma sep

* Give action a clearer name

* Fix dev-portal cache

* Revert testing changes

* Put back space

* Migrate over terraform-cdk (#229)

* API Compare tool for version metadata (#232)

* Add readme

* Update command in package.json

* Add test output folder to gitignore

* Shorten example response

* Add default values for old and new APIs

---------

Co-authored-by: Ruben Nic <[email protected]>

* Fix merge conflict (#252)

* Keep develop in sync with main (#251)

* Fix content not showing up in preview and link checker checking more than *.mdx files (#226)

* Broken link checker should only run on .mdx files

* Add a test to catch a broken link

* Edit a JSON file

* Move to always using head.sha when link checking

* Miss a place for the head.sha

* print the changed files

* Move back to using nick-fields/retry

* Fix misspelling and add another test

* Fix wrong var being pass in

* Fix misspelling of variable

* Found another misspelling :face_palm:

* get-changed-files output is space not comma sep

* Give action a clearer name

* Fix dev-portal cache

* Revert testing changes

* Put back space

* Enable vercel deployment protection bypass (#230)

* Expand lychee command to multiple lines

This makes the arguments easier to read (multiple small lines rather than one
line line that stretches for miles)

* Add vercel protection bypass header to lychee command

* Disable prod workflows outside of public repo (#234)

* Disable prod workflows outside of public repo

* Moving to using job level if

* Mock imports in app/utils/utils.test.ts to run without prebuild step (#238)

* Mock import in app/api/content/[productSlug]/redirects/route.test.ts to run without prebuild step (#241)

* Mock imports in app/api/all-docs-paths/route.test.ts to run without prebuild step (#239)

* Mock imports in app/utils/allDocsPaths.test.ts to run without prebuild step (#237)

* repo sync between public and internal repos for web-unifed-docs GHA (#236)

* Change repo owner to hashicorp in repo-sync workflow (#242)

* Mock import of version metadata in app/api/content/[productSlug]/version-metadata/route.ts (#240)

* Mock import of version metadata (#244)

* Mock import of versionMetadata in app/api/assets/[productSlug]/[version]/[...assetPath]/route.test.ts(#245)

* Mock imports in app/api/content/[productSlug]/doc/[version]/[...docsPath]/route.test.ts (#243)

* Mock imports for versionMetadata.json, docsPathsAllVersions.json, and productConfig.mjs

* Remove path navigation from fixtures import (#1) (#247)

* sync changes from web-unified-docs-internal

* Update method from compareCommits to compareCommitsWithBasehead (#249)

* Remove prebuild from test action (#250)

* Add develop to target branches

---------

Co-authored-by: Ruben Nic <[email protected]>
Co-authored-by: Robert Main <[email protected]>
Co-authored-by: HashiBot <[email protected]>

* api comparison tool: content versions (#340)

* Change arg to d for drop-keys

* Added functionality to test content-versions API

* Add examples to the readme

* Sync changes from main into develop (#344)

* Fix content not showing up in preview and link checker checking more than *.mdx files (#226)

* Broken link checker should only run on .mdx files

* Add a test to catch a broken link

* Edit a JSON file

* Move to always using head.sha when link checking

* Miss a place for the head.sha

* print the changed files

* Move back to using nick-fields/retry

* Fix misspelling and add another test

* Fix wrong var being pass in

* Fix misspelling of variable

* Found another misspelling :face_palm:

* get-changed-files output is space not comma sep

* Give action a clearer name

* Fix dev-portal cache

* Revert testing changes

* Put back space

* Enable vercel deployment protection bypass (#230)

* Expand lychee command to multiple lines

This makes the arguments easier to read (multiple small lines rather than one
line line that stretches for miles)

* Add vercel protection bypass header to lychee command

* Disable prod workflows outside of public repo (#234)

* Disable prod workflows outside of public repo

* Moving to using job level if

* Mock imports in app/utils/utils.test.ts to run without prebuild step (#238)

* Mock import in app/api/content/[productSlug]/redirects/route.test.ts to run without prebuild step (#241)

* Mock imports in app/api/all-docs-paths/route.test.ts to run without prebuild step (#239)

* Mock imports in app/utils/allDocsPaths.test.ts to run without prebuild step (#237)

* repo sync between public and internal repos for web-unifed-docs GHA (#236)

* Change repo owner to hashicorp in repo-sync workflow (#242)

* Mock import of version metadata in app/api/content/[productSlug]/version-metadata/route.ts (#240)

* Mock import of version metadata (#244)

* Mock import of versionMetadata in app/api/assets/[productSlug]/[version]/[...assetPath]/route.test.ts(#245)

* Mock imports in app/api/content/[productSlug]/doc/[version]/[...docsPath]/route.test.ts (#243)

* Mock imports for versionMetadata.json, docsPathsAllVersions.json, and productConfig.mjs

* Remove path navigation from fixtures import (#1)

* Remove path navigation from fixtures import (#1) (#247)

* sync changes from web-unified-docs-internal

* Update method from compareCommits to compareCommitsWithBasehead (#249)

* Remove prebuild from test action (#250)

* Add develop to target branches

* Remove paths arg to allow Test & Lint action to run on every PR (#253)

* Remove PR lock logic from repo-sync workflow (#263)

* Repo sync (#34)

* Remove path navigation from fixtures import (#1) (#247)

* sync changes from web-unified-docs-internal

* Update method from compareCommits to compareCommitsWithBasehead (#249)

* Remove prebuild from test action (#250)

* Add develop to target branches

* Remove paths arg to allow Test & Lint action to run on every PR (#253)

* Remove PR lock logic from repo-sync workflow (#263)

---------

Co-authored-by: Heat Hamilton <[email protected]>

* Repo sync (#291)



* Repo sync (#34)

* sync changes from web-unified-docs-internal

* Update method from compareCommits to compareCommitsWithBasehead (#249)

* Remove prebuild from test action (#250)

* Add develop to target branches

* Remove paths arg to allow Test & Lint action to run on every PR (#253)

* Remove PR lock logic from repo-sync workflow (#263)

---------

Co-authored-by: Heat Hamilton <[email protected]>

* Repo sync (#38)

* sync changes from web-unified-docs-internal

* Update method from compareCommits to compareCommitsWithBasehead (#249)

* Remove prebuild from test action (#250)

* Add develop to target branches

* Remove paths arg to allow Test & Lint action to run on every PR (#253)

* Remove PR lock logic from repo-sync workflow (#263)

---------

Co-authored-by: Heat Hamilton <[email protected]>

* Add Vercel link to deploy preview (#39)

* Add Vercel link to deploy job (#290)

* Fix for dev-portal is failing to build in UDR internal repo

* Repo sync (#326)

* Repo sync (#73)

* Fix content loading (#235)

* Use vercel protection bypass headcer

Builds were previously breaking when UDR attempted to make HTTP requests to the
CDN (vercel public folder) to retrieve content.

Adding the `x-vercel-protection-bypass` header should fix that

* Add use server directive

* Revert "Add use server directive"

Adding a 'use server' directive to this file causes 404s on the content
API.

This reverts commit 4f2ecae.

---------

Co-authored-by: Ruben Nic <[email protected]>
Co-authored-by: Heat Hamilton <[email protected]>
Co-authored-by: HashiBot <[email protected]>

* Remove terraform docs common (#342)

* Remove terraform-docs-common from develop branch

* Comment out terraform-docs-common

Disable terraform-docs-common in product config

* Undo removal of content dir mapping

---------

Co-authored-by: Heat Hamilton <[email protected]>

* Add terraform-docs-agents (#345)

* remove terraform-cdk docs (#347)

* Re-sync terraform-docs-agents docs (#348)

Co-authored-by: Ruben Nic <[email protected]>

* Update image file paths for terraform-docs-agents (#350)

* Change image path from public/img to img

Comment out themed images and add TODO for when this is supported

Add TODO to remove non-themed image once themed images are supported

* Remove commented out images

* Delete images from v1.15.x and v1.16.x

* Copy over images from v1.17.x

* Add ptfe release PR request template

* Add TFE release notes workflow (#367)

* Add clone services repo script

* Move config files into script folder

* Add execute changelog script

* add create pull request script

* add workflow file

* Workflow needs to run once to test

* Add the release notes PR url to the summary

* Correctly get env.VERSION

* Correctly expand PR_URL

* Just don't use PR_URL as it isn't expanding

* Remove push dispatch, as no longer needed

* I don't believe PR_NUMBER is being set correctly

* Set PR_NUMBER in multiple steps

* Try each step separately

* Return pr_url from ruby

* Let pr_url should be a var

* Should be double quotes

* Fix summary output

* Add gem lock file

* Add push so I can test workflow

* A few more places where ptfe-releases is used

* Rename ptfe -> tfe

* content folder should be terraform-enterprise

* Forgot to update release_file loc

* Prevent from running in public UDR

* Output public UDR error to GITHUB_STEP_SUMMARY

* Apply suggestions from code review

Co-authored-by: Leah Bush <[email protected]>

* Remove commented out code

---------

Co-authored-by: Leah Bush <[email protected]>

---------

Co-authored-by: Heat Hamilton <[email protected]>
Co-authored-by: Robert Main <[email protected]>
Co-authored-by: HashiBot <[email protected]>
Co-authored-by: Leah Bush <[email protected]>

* Add tfe-releases copyright headers (#394)

* Updates for tfc-agent release 1.22.2

* Undo generated removal of include policy

* Compress upload into gzipped tarball (#396)

* Compress upload into gzipped tarball

This helps to resolve an issue that was breaking preview deploys where
too many files were being uploaded at once

* Move command option within parens

Accidentally added the `--archive` option outside parens which would result in it not being passed to `vercel` as intended.

Co-authored-by: Leah Bush <[email protected]>

* Bundle vercel deployment into tgz archive for prod

Similar to 518efc4 - update the deploy UDR action to first bundle
everything into a tgz archive prior to upload to vercel to avoid hitting
API file count limits (8000 for enterprise plans)

* Add base branch for testing to GH action

* Remove branch name from pull_request_target

---------

Co-authored-by: Leah Bush <[email protected]>

* feat: add all-docs-paths to compare-api-responses script (#391)

* Add `[email protected]` documentation (#400)

* Add `[email protected]` documentation (#346)

* initial copy of terraform-plugin-testing 1.12.x to 1.13.x

$ cp -r content/terraform-plugin-testing/v1.12.x content/terraform-plugin-testing/v1.13.x
$ git add content/terraform-plugin-testing/v1.13.x

* Add import mode to testing-patterns.mdx

* fixup! Add import mode to testing-patterns.mdx

* Update content/terraform-plugin-testing/v1.13.x/docs/plugin/testing/testing-patterns.mdx

* Update content/terraform-plugin-testing/v1.13.x/docs/plugin/testing/testing-patterns.mdx

Co-authored-by: Austin Valle <[email protected]>

* Add teststep subsection for import mode

* Add teststep subsection for import mode

* Add teststep subsection for import mode

* Expand on import mode

* Update plugin/testing/acceptance-tests/index.mdx

* Update acceptance-tests/index.mdx

* Update acceptance-tests/index.mdx

* em dash

* Update acceptance-tests/continuous-integration

* Update acceptance-tests/index.mdx

* Update import-mode.mdx

* Update acceptance-tests/index.mdx

* tidy

* Update testing/index.mdx

* Update testing/index.mdx

* Update testing nav

* Update testing/index.mdx

* Update testing/index.mdx

* Fix code block

* Update testing/*

* Simplify acceptance-tests

* Omit import example

* Update content/terraform-plugin-testing/v1.13.x/docs/plugin/testing/acceptance-tests/environment-variables.mdx

Co-authored-by: Austin Valle <[email protected]>

* Fix environment-variables.mdx formatting

* Fix environment-variables.mdx formatting

* Tidy

* Update content/terraform-plugin-testing/v1.13.x/docs/plugin/testing/acceptance-tests/continuous-integration.mdx

Co-authored-by: Austin Valle <[email protected]>

* Update content/terraform-plugin-testing/v1.13.x/docs/plugin/testing/acceptance-tests/import-mode.mdx

Co-authored-by: Austin Valle <[email protected]>

* Apply suggestions from code review

Co-authored-by: Austin Valle <[email protected]>

* Tidy

* Make heading H1

* Tidy import-mode

---------

Co-authored-by: Austin Valle <[email protected]>

* Add `[email protected]` documentation (#355)

* copy 1.14.x to new folder

* Framework - Resource Identity Documentation (#361)

* add skeleton of thoughts on doc updates

* Initial update to reflect the addition of resource identity.mdx

* Second update of documentation to address some comments

* Removing extra line

* Update content/terraform-plugin-framework/v1.15.x/docs/plugin/framework/resources/identity.mdx

Co-authored-by: Rose M Koron <[email protected]>

* adjust type pages

* Apply suggestions from code review

Co-authored-by: Rose M Koron <[email protected]>

* remove stack + note callout

* add to nav

* update code examples and change name back

* update identity docs

* more identity updates

* updates + todos

* space

* remove sections

* last updates to identity docs

---------

Co-authored-by: Rain <[email protected]>
Co-authored-by: Rain Kwan <[email protected]>
Co-authored-by: Rose M Koron <[email protected]>

---------

Co-authored-by: Rain <[email protected]>
Co-authored-by: Rain Kwan <[email protected]>
Co-authored-by: Rose M Koron <[email protected]>

* Make agent eng team owners of agent docs

* Ignore gnu.org domain in link checker (#401)

* ignore gnu domain in link checker

* Test to make sure that the GNU domain is skipped

* Add `terraform-plugin-sdk/[email protected]` documentation (#356)

* copy v2.36.x to new folder

* add identity changes (#402)

* Merge develop into main in preparation for launch (#425)

* Migrate terraform-docs-common (#227)

* Migrate terraform-docs-agents (#228)

* Fix content not showing up in preview and link checker checking more than *.mdx files (#226) (#231)

* Broken link checker should only run on .mdx files

* Add a test to catch a broken link

* Edit a JSON file

* Move to always using head.sha when link checking

* Miss a place for the head.sha

* print the changed files

* Move back to using nick-fields/retry

* Fix misspelling and add another test

* Fix wrong var being pass in

* Fix misspelling of variable

* Found another misspelling :face_palm:

* get-changed-files output is space not comma sep

* Give action a clearer name

* Fix dev-portal cache

* Revert testing changes

* Put back space

* Migrate over terraform-cdk (#229)

* API Compare tool for version metadata (#232)

* Add readme

* Update command in package.json

* Add test output folder to gitignore

* Shorten example response

* Add default values for old and new APIs

---------

Co-authored-by: Ruben Nic <[email protected]>

* Fix merge conflict (#252)

* Keep develop in sync with main (#251)

* Fix content not showing up in preview and link checker checking more than *.mdx files (#226)

* Broken link checker should only run on .mdx files

* Add a test to catch a broken link

* Edit a JSON file

* Move to always using head.sha when link checking

* Miss a place for the head.sha

* print the changed files

* Move back to using nick-fields/retry

* Fix misspelling and add another test

* Fix wrong var being pass in

* Fix misspelling of variable

* Found another misspelling :face_palm:

* get-changed-files output is space not comma sep

* Give action a clearer name

* Fix dev-portal cache

* Revert testing changes

* Put back space

* Enable vercel deployment protection bypass (#230)

* Expand lychee command to multiple lines

This makes the arguments easier to read (multiple small lines rather than one
line line that stretches for miles)

* Add vercel protection bypass header to lychee command

* Disable prod workflows outside of public repo (#234)

* Disable prod workflows outside of public repo

* Moving to using job level if

* Mock imports in app/utils/utils.test.ts to run without prebuild step (#238)

* Mock import in app/api/content/[productSlug]/redirects/route.test.ts to run without prebuild step (#241)

* Mock imports in app/api/all-docs-paths/route.test.ts to run without prebuild step (#239)

* Mock imports in app/utils/allDocsPaths.test.ts to run without prebuild step (#237)

* repo sync between public and internal repos for web-unifed-docs GHA (#236)

* Change repo owner to hashicorp in repo-sync workflow (#242)

* Mock import of version metadata in app/api/content/[productSlug]/version-metadata/route.ts (#240)

* Mock import of version metadata (#244)

* Mock import of versionMetadata in app/api/assets/[productSlug]/[version]/[...assetPath]/route.test.ts(#245)

* Mock imports in app/api/content/[productSlug]/doc/[version]/[...docsPath]/route.test.ts (#243)

* Mock imports for versionMetadata.json, docsPathsAllVersions.json, and productConfig.mjs

* Remove path navigation from fixtures import (#1) (#247)

* sync changes from web-unified-docs-internal

* Update method from compareCommits to compareCommitsWithBasehead (#249)

* Remove prebuild from test action (#250)

* Add develop to target branches

---------

Co-authored-by: Ruben Nic <[email protected]>
Co-authored-by: Robert Main <[email protected]>
Co-authored-by: HashiBot <[email protected]>

* api comparison tool: content versions (#340)

* Change arg to d for drop-keys

* Added functionality to test content-versions API

* Add examples to the readme

* Sync changes from main into develop (#344)

* Fix content not showing up in preview and link checker checking more than *.mdx files (#226)

* Broken link checker should only run on .mdx files

* Add a test to catch a broken link

* Edit a JSON file

* Move to always using head.sha when link checking

* Miss a place for the head.sha

* print the changed files

* Move back to using nick-fields/retry

* Fix misspelling and add another test

* Fix wrong var being pass in

* Fix misspelling of variable

* Found another misspelling :face_palm:

* get-changed-files output is space not comma sep

* Give action a clearer name

* Fix dev-portal cache

* Revert testing changes

* Put back space

* Enable vercel deployment protection bypass (#230)

* Expand lychee command to multiple lines

This makes the arguments easier to read (multiple small lines rather than one
line line that stretches for miles)

* Add vercel protection bypass header to lychee command

* Disable prod workflows outside of public repo (#234)

* Disable prod workflows outside of public repo

* Moving to using job level if

* Mock imports in app/utils/utils.test.ts to run without prebuild step (#238)

* Mock import in app/api/content/[productSlug]/redirects/route.test.ts to run without prebuild step (#241)

* Mock imports in app/api/all-docs-paths/route.test.ts to run without prebuild step (#239)

* Mock imports in app/utils/allDocsPaths.test.ts to run without prebuild step (#237)

* repo sync between public and internal repos for web-unifed-docs GHA (#236)

* Change repo owner to hashicorp in repo-sync workflow (#242)

* Mock import of version metadata in app/api/content/[productSlug]/version-metadata/route.ts (#240)

* Mock import of version metadata (#244)

* Mock import of versionMetadata in app/api/assets/[productSlug]/[version]/[...assetPath]/route.test.ts(#245)

* Mock imports in app/api/content/[productSlug]/doc/[version]/[...docsPath]/route.test.ts (#243)

* Mock imports for versionMetadata.json, docsPathsAllVersions.json, and productConfig.mjs

* Remove path navigation from fixtures import (#1)

* Remove path navigation from fixtures import (#1) (#247)

* sync changes from web-unified-docs-internal

* Update method from compareCommits to compareCommitsWithBasehead (#249)

* Remove prebuild from test action (#250)

* Add develop to target branches

* Remove paths arg to allow Test & Lint action to run on every PR (#253)

* Remove PR lock logic from repo-sync workflow (#263)

* Repo sync (#34)

* Remove path navigation from fixtures import (#1) (#247)

* sync changes from web-unified-docs-internal

* Update method from compareCommits to compareCommitsWithBasehead (#249)

* Remove prebuild from test action (#250)

* Add develop to target branches

* Remove paths arg to allow Test & Lint action to run on every PR (#253)

* Remove PR lock logic from repo-sync workflow (#263)

---------

Co-authored-by: Heat Hamilton <[email protected]>

* Repo sync (#291)



* Repo sync (#34)

* sync changes from web-unified-docs-internal

* Update method from compareCommits to compareCommitsWithBasehead (#249)

* Remove prebuild from test action (#250)

* Add develop to target branches

* Remove paths arg to allow Test & Lint action to run on every PR (#253)

* Remove PR lock logic from repo-sync workflow (#263)

---------

Co-authored-by: Heat Hamilton <[email protected]>

* Repo sync (#38)

* sync changes from web-unified-docs-internal

* Update method from compareCommits to compareCommitsWithBasehead (#249)

* Remove prebuild from test action (#250)

* Add develop to target branches

* Remove paths arg to allow Test & Lint action to run on every PR (#253)

* Remove PR lock logic from repo-sync workflow (#263)

---------

Co-authored-by: Heat Hamilton <[email protected]>

* Add Vercel link to deploy preview (#39)

* Add Vercel link to deploy job (#290)

* Fix for dev-portal is failing to build in UDR internal repo

* Repo sync (#326)

* Repo sync (#73)

* Fix content loading (#235)

* Use vercel protection bypass headcer

Builds were previously breaking when UDR attempted to make HTTP requests to the
CDN (vercel public folder) to retrieve content.

Adding the `x-vercel-protection-bypass` header should fix that

* Add use server directive

* Revert "Add use server directive"

Adding a 'use server' directive to this file causes 404s on the content
API.

This reverts commit 4f2ecae.

---------

Co-authored-by: Ruben Nic <[email protected]>
Co-authored-by: Heat Hamilton <[email protected]>
Co-authored-by: HashiBot <[email protected]>

* Remove terraform docs common (#342)

* Remove terraform-docs-common from develop branch

* Comment out terraform-docs-common

Disable terraform-docs-common in product config

* Undo removal of content dir mapping

---------

Co-authored-by: Heat Hamilton <[email protected]>

* Add terraform-docs-agents (#345)

* remove terraform-cdk docs (#347)

* Re-sync terraform-docs-agents docs (#348)

Co-authored-by: Ruben Nic <[email protected]>

* Update image file paths for terraform-docs-agents (#350)

* Change image path from public/img to img

Comment out themed images and add TODO for when this is supported

Add TODO to remove non-themed image once themed images are supported

* Remove commented out images

* Delete images from v1.15.x and v1.16.x

* Copy over images from v1.17.x

* Add ptfe release PR request template

* Add TFE release notes workflow (#367)

* Add clone services repo script

* Move config files into script folder

* Add execute changelog script

* add create pull request script

* add workflow file

* Workflow needs to run once to test

* Add the release notes PR url to the summary

* Correctly get env.VERSION

* Correctly expand PR_URL

* Just don't use PR_URL as it isn't expanding

* Remove push dispatch, as no longer needed

* I don't believe PR_NUMBER is being set correctly

* Set PR_NUMBER in multiple steps

* Try each step separately

* Return pr_url from ruby

* Let pr_url should be a var

* Should be double quotes

* Fix summary output

* Add gem lock file

* Add push so I can test workflow

* A few more places where ptfe-releases is used

* Rename ptfe -> tfe

* content folder should be terraform-enterprise

* Forgot to update release_file loc

* Prevent from running in public UDR

* Output public UDR error to GITHUB_STEP_SUMMARY

* Apply suggestions from code review

Co-authored-by: Leah Bush <[email protected]>

* Remove commented out code

---------

Co-authored-by: Leah Bush <[email protected]>

* Add in ptfe-releases content (#393)

* Add in ptfe-releases content

* Add tfe-releases copyright headers

* feat: add terraform-docs-common to develop branch (#395)

* Copy docs workflow (#404)

* Add enough for barebones test

* Add push for testing

* Fix workflow name

* Add test file at root to check that PR opens

* login with github token

* Update gh token

* Try just a git push

* Add back push head

* merge into develop for now

* Remove push action

* remove comment that was messing up code

* Get copy-cloud-docs-for-tfe compiling

* Only building only version metadata

* Refactor to remove targetRepoLastSyncFile

* Downgrade remark to fix mdx v2 errors

* Get Copy cloud-docs for TFE working

* Check if the branch name already exists

* Fix type errors

* Update the README with the new name

* Test the whole workflow connected together

* checkout the proper workflow file before running

* path should be a string

* forgot a period

* Use latest sha for GHA run

* Forgot to build 🤦

* double check that the checkout is working

* Add the current loc to checkout

* try the path just "testing"

* include the github workspace

* It's github.workspace

* checkout is deleting previous folder contents

* Double check that the files are being moved over

* fix move command

* fix a space in path

* list files for debugging

* What is in our base dir

* copy dot files

* correct file path

* For demo only add changed files in /ptfe-releases

* For the sake of the demo do a clean PR

* Forgot to rebuild

* base against develop

* new-pr checkout should be develop as well

* clean up testing code

* Don't copy over /architectural-details

* Corrected new-pr path

* prebuild-only-version-metadata exists in branch

* Correctly fetch the origin branch

* use working-directory

* Rewrite to support two different PRs

* Resolve the versionMetadataPath

* Fix working dir and branch checking code

* Remove branch checking code

* Try a new way to check for a branch existing

* try again for branch checking

* should be a "do not equals"

* Update bot user

* Add diff PR to workflow

* Update PR names

* Update a bit of the wording

* Remove testing code

* Trigger copy docs from release notes workflow

* delete old tests as they are no longer being used

* Add copywrite headers

* Add todos to workflow

* Add parenthesis around closed message

* Update README and remove code comment

* Remove TODOs and base off of main

* Update .github/actions/copy-cloud-docs-for-tfe/main.ts

Co-authored-by: Robert Main <[email protected]>

---------

Co-authored-by: Heat Hamilton <[email protected]>
Co-authored-by: Robert Main <[email protected]>
Co-authored-by: HashiBot <[email protected]>
Co-authored-by: Leah Bush <[email protected]>
Co-authored-by: Leah Bush <[email protected]>

* Forgot to update a path (#426)

* Forgot one other path... (#428)

* Actually update the path (#429)

* Update path in GHA (#430)

* Update path in GHA

* update build output

* Rename ptfe-releases to terraform-enterprise (#419)

* Rename PTFE Release Folder

Renames PTFE releases folder to terraform-enterprise

* Change PTFE Releases Product Config to TFE

* Redirect /ptfe-releases to /terraform-enterprise

* Update reference to ptfe-releases

Update code comments to make reference to terraform-enterprise, not
pfe-releases

* Add missing license header

* Update mermaid README diagram

Terraform is about to be migrated to UDR, so this diagram needed to be
updated to reflect that

* Refactor to remove references to ptfe-releases

Since #425 got merged into the base branch before this PR, additional
references to `/ptfe-releases` were re-introduced. These needed to be
removed in order for things to build and load correctly.

* Don't check compiled actions for missing copyright header (#436)

The content of this action is(somewhat) auto generated by `ncc` meaning we don't have a great deal of control over its content. Therefore, we can probably safely ignore it when checking for missing copyright headers as it is isn't a source file

* fix terraform docs common metadata (#438)

* Assign a placeholder version for unversioned docs

* Move all TFC versions to 'v0.0.x'

* Give version less docs a version

* Use PRODUCT_CONFIG when we can

* fix sitemaps for terraform-docs-common

* Check PRODUCT_CONFIG in more places

* fix file path

* remove console.log

* fix docs route tests

* change back to null

* fix more tests

* fix gather-version tests

* fix test

* put aloglia check back

* fix tests

* remove extra console.log

---------

Co-authored-by: Leah Bush <[email protected]>

* Updates for tfc-agent release 1.22.3

* chore: add terraform docs to UDR (#437)

* Add `[email protected]` documentation (#424)

* Update codeowners for ptfe and tdc (#441)

* Add terraform-docs-common CODEOWNERS

* Add terraform-enterprise to CODEOWNERS

* Add missing team to terraform-docs-common

* chore: add terraform teams to codeowners (#442)

* chore: add terraform teams to codeowners

* add terraform backend codeowners

* use wildcards

* Sync ptfe-releases and terraform-docs-common docs (#440)

* terraform-docs-common

* terraform-enterprise

* Apply middleware to all api routes (#451)

* Initial draft

* do a dirty rewrite for query params

* Update diff PR to merge into release PR (#443)

* Update diff PR to merge into release PR

* forgot to put env before a var

* fix get latest terraform-enterprise version

* Update step titles to match

* Added /app to dir when not needed

* Update gh cli action to edit

* Copy file contents not the whole file

* Diff PR should start on Release PR ref

* Update PRs wording

* Clean up secrets and add ability to trigger notify

---------

Co-authored-by: Ruben Nic <[email protected]>
Co-authored-by: Heat Hamilton <[email protected]>
Co-authored-by: Robert Main <[email protected]>
Co-authored-by: Leah Bush <[email protected]>
Co-authored-by: Claire Knutson <[email protected]>
Co-authored-by: Claire Knutson <[email protected]>
Co-authored-by: Austin Valle <[email protected]>
Co-authored-by: Baraa Basata <[email protected]>
Co-authored-by: Rain <[email protected]>
Co-authored-by: Rain Kwan <[email protected]>
Co-authored-by: Rose M Koron <[email protected]>
Co-authored-by: Krista LaFentres <[email protected]>
Co-authored-by: Leah Bush <[email protected]>
Co-authored-by: Kelsi Hoyle <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants